Add Card Holder with primary address

Create a card holder with the address provided at the time of onboarding the customer.

Method: POST

{{URL}}/cardv2

Headers

Name	Value
Content-Type	application/json

Payload Parameters

Parameters	Description
reference Optional	String Unique reference ID of the request Sample value: "9932487793635"
transactionType Mandatory	String Type of operation/transaction Constant value: "ADD_CARD_HOLDER_WITH_PRIMARY_ADDRESS"
customerId Mandatory	String Unique Id of the customer Sample value: "100000000033002"
accountNumber Mandatory	String Account number of the customer Sample value: "210199823931012"
product Mandatory	String Name of the product associated with the card Sample value: "DEFAULT"
channel Mandatory	Enum Processing channel through which the card transaction happens Valid values: PULSE VISA_DPS Sample value: "VISA_DPS"
program Mandatory	String Name of the program to which the card product is mapped Sample value: "DEFAULT"

Example

cURL

curl --location --globoff '{{URL}}/cardv2' \
--header 'Content-Type: application/json' \
--data '{"method":"ledger.CARD.request","id":"1","params":{"payload":{"reference":"9932487793635","transactionType":"ADD_CARD_HOLDER_WITH_PRIMARY_ADDRESS","customerId":"100000000033002","accountNumber":"210199823931012","product":"DEFAULT","channel":"VISA_DPS","program":"DEFAULT"},"api":{"signature":"{{signature}}","apiKey":"{{Api-key}}","credential":"{{cred}}"}}}'

C#

var options = new RestClientOptions("{{URL}}/cardv2")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""method"": ""ledger.CARD.request"",
" + "\n" +
@"    ""id"": ""1"",
" + "\n" +
@"    ""params"": {
" + "\n" +
@"        ""payload"": {
" + "\n" +
@"            ""reference"": ""9932487793635"",
" + "\n" +
@"            ""transactionType"": ""ADD_CARD_HOLDER_WITH_PRIMARY_ADDRESS"",
" + "\n" +
@"            ""customerId"": ""100000000033002"",
" + "\n" +
@"            ""accountNumber"": ""210199823931012"",
" + "\n" +
@"            ""product"": ""DEFAULT"",
" + "\n" +
@"            ""channel"": ""VISA_DPS"",
" + "\n" +
@"            ""program"": ""DEFAULT""
" + "\n" +
@"        },
" + "\n" +
@"        ""api"": {
" + "\n" +
@"            ""signature"": ""{{signature}}"",
" + "\n" +
@"            ""apiKey"": ""{{Api-key}}"",
" + "\n" +
@"            ""credential"": ""{{cred}}""
" + "\n" +
@"        }
" + "\n" +
@"    }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{URL}}/cardv2"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "method": "ledger.CARD.request",`+"
"+`
    "id": "1",`+"
"+`
    "params": {`+"
"+`
        "payload": {`+"
"+`
            "reference": "9932487793635",`+"
"+`
            "transactionType": "ADD_CARD_HOLDER_WITH_PRIMARY_ADDRESS",`+"
"+`
            "customerId": "100000000033002",`+"
"+`
            "accountNumber": "210199823931012",`+"
"+`
            "product": "DEFAULT",`+"
"+`
            "channel": "VISA_DPS",`+"
"+`
            "program": "DEFAULT"`+"
"+`
        },`+"
"+`
        "api": {`+"
"+`
            "signature": "{{signature}}",`+"
"+`
            "apiKey": "{{Api-key}}",`+"
"+`
            "credential": "{{cred}}"`+"
"+`
        }`+"
"+`
    }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/cardv2',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "method": "ledger.CARD.request",
  "id": "1",
  "params": {
    "payload": {
      "reference": "9932487793635",
      "transactionType": "ADD_CARD_HOLDER_WITH_PRIMARY_ADDRESS",
      "customerId": "100000000033002",
      "accountNumber": "210199823931012",
      "product": "DEFAULT",
      "channel": "VISA_DPS",
      "program": "DEFAULT"
    },
    "api": {
      "signature": "{{signature}}",
      "apiKey": "{{Api-key}}",
      "credential": "{{cred}}"
    }
  }
});

req.write(postData);

req.end();

Body

{
    "method": "ledger.CARD.request",
    "id": "1",
    "params": {
        "payload": {
            "reference": "9932487793635",
            "transactionType": "ADD_CARD_HOLDER_WITH_PRIMARY_ADDRESS",
            "customerId": "100000000033002",
            "accountNumber": "210199823931012",
            "product": "DEFAULT",
            "channel": "VISA_DPS",
            "program": "DEFAULT"
        },
        "api": {
            "signature": "{{signature}}",
            "apiKey": "{{Api-key}}",
            "credential": "{{cred}}"
        }
    }
}

Response: 200

Response Parameters

Parameters	Description
id	String Response Id echoed from the request Id Sample value: " 1"
result	Object
cardHolderId	String Unique id of the card holder Sample value: " CH00000000019001"
api	Object
type	String Acknowledgement for type of operation requested for Constant value: " ADD_CARD_HOLDER_WITH_PRIMARY_ADDRESS_ACK"
reference	String Auto generated reference ID of this acknowledgment Sample value: " REF9932487793635"
dateCreated	Number Unix timestamp of the response was created Sample value: 1730723921
originalReference	String Original reference ID taken from the request Sample value: " 9932487793635"

{
  "id": "1",
  "result": {
    "cardHolderId": "CH00000000019001",
    "api": {
      "type": "ADD_CARD_HOLDER_WITH_PRIMARY_ADDRESS_ACK",
      "reference": "REF9932487793635",
      "dateCreated": 1730723921,
      "originalReference": "9932487793635"
    }
  }
}